.TH RST2ODT "1" "January 2008" "docutils" "User Commands"
.SH NAME
rst2odt \- convert reST documents to ODT
.SH SYNOPSIS
.B rst2odt
[\fIoptions\fR] [\fIsource\fR [\fIdestination\fR]]
.SH DESCRIPTION
.PP
Generates OpenDocument Text (ODT) documents from reStructuredText sources.
Reads from \fIsource\fR (default is stdin) and writes to \fIdestination\fR
(default is stdout).
.SH OPTIONS

.SS
\fBGeneral Docutils Options\fR
.TP
\fB\-\-title\fR=\fITITLE\fR
Specify the document title as metadata (not part of
the document body).  Overrides a document-provided
title.  There is no default.
.TP
\fB\-\-generator\fR, \fB\-g\fR
Include a "Generated by Docutils" credit and link at
the end of the document.
.TP
\fB\-\-no\-generator\fR
Do not include a generator credit.
.TP
\fB\-\-date\fR, \fB\-d\fR
Include the date at the end of the document (UTC).
.TP
\fB\-\-time\fR, \fB\-t\fR
Include the time & date at the end of the document
(UTC).
.TP
\fB\-\-no\-datestamp\fR
Do not include a datestamp of any kind.
.TP
\fB\-\-source\-link\fR, \fB\-s\fR
Include a "View document source" link (relative to
destination).
.TP
\fB\-\-source\-url\fR=\fI<URL>\fR
Use the supplied <URL> verbatim for a "View document
source" link; implies \-\-source-link.
.TP
\fB\-\-no\-source\-link\fR
Do not include a "View document source" link.
.TP
\fB\-\-toc\-entry\-backlinks\fR
Enable backlinks from section headers to table of
contents entries.  This is the default.
.TP
\fB\-\-toc\-top\-backlinks\fR
Enable backlinks from section headers to the top of
the table of contents.
.TP
\fB\-\-no\-toc\-backlinks\fR
Disable backlinks to the table of contents.
.TP
\fB\-\-footnote\-backlinks\fR
Enable backlinks from footnotes and citations to their
references.  This is the default.
.TP
\fB\-\-no\-footnote\-backlinks\fR
Disable backlinks from footnotes and citations.
.TP
\fB\-\-section\-numbering\fR
Enable Docutils section numbering (default: enabled).
.TP
\fB\-\-no\-section\-numbering\fR
Disable Docutils section numbering (default: enabled).
.TP
\fB\-\-strip\-comments\fR
Remove comment elements from the document tree
(default: leave them).
.TP
\fB\-\-leave\-comments\fR
Leave comment elements in the document tree (this is
the default).
.TP
\fB\-\-report\fR=\fI<level>\fR, \fB\-r\fR \fI<level>\fR
Set verbosity threshold; report system messages at or
higher than <level> (by name or number: "info" or "1",
warning/2, error/3, severe/4; also, "none" or "5").
Default is 2 (warning).
.TP
\fB\-\-verbose\fR, \fB\-v\fR
Report all system messages, info-level and higher.
(Same as "\-\-report=info".)
.TP
\fB\-\-quiet\fR, \fB\-q\fR
Do not report any system messages.  (Same as
"\-\-report=none".)
.TP
\fB\-\-halt\fR=\fI<level>\fR
Set the threshold (<level>) at or above which system
messages are converted to exceptions, halting
execution immediately by exiting (or propagating the
exception if \-\-traceback set).  Levels as in \-\-report.
Default is 4 (severe).
.TP
\fB\-\-strict\fR
Same as "\-\-halt=info": halt processing at the
slightest problem.
.TP
\fB\-\-exit\-status\fR=\fI<level>\fR
Enable a non-zero exit status for normal exit if
non-halting system messages (at or above <level>) were
generated.  Levels as in \-\-report.  Default is 5
(disabled).  Exit status is the maximum system message
level plus 10 (11 for INFO, etc.).
.TP
\fB\-\-debug\fR
Report debug-level system messages and generate
diagnostic output.
.TP
\fB\-\-no\-debug\fR
Do not report debug-level system messages or generate
diagnostic output.
.TP
\fB\-\-warnings\fR=\fI<file>\fR
Send the output of system messages (warnings) to
<file>.
.TP
\fB\-\-traceback\fR
Enable Python tracebacks when halt-level system
messages and other exceptions occur.  Useful for
debugging, and essential for issue reports.
.TP
\fB\-\-no\-traceback\fR
Disable Python tracebacks when errors occur; report
just the error instead.  This is the default.
.TP
\fB\-\-input\-encoding\fR=\fI<name[:handler]>\fR, \fB\-i\fR \fI<name[:handler]>\fR
Specify the encoding of input text.  Default is
locale-dependent.  Optionally also specify the error
handler for undecodable characters, after a colon
(":"); default is "strict".
(See "\-\-input-encoding-error-handler".)
.TP
\fB\-\-input\-encoding\-error\-handler\fR=\fIINPUT_ENCODING_ERROR_HANDLER\fR
Specify the error handler for undecodable characters
in the input.  Acceptable values include "strict",
"ignore", and "replace".  Default is "strict".
Usually specified as part of \-\-input-encoding.
.TP
\fB\-\-output\-encoding\fR=\fI<name[:handler]>\fR, \fB\-o\fR \fI<name[:handler]>\fR
Specify the text encoding for output.  Default is
UTF-8.  Optionally also specify the error handler for
unencodable characters, after a colon (":"); default
is "strict".  (See "\-\-output-encoding-error-handler".)
.TP
\fB\-\-output\-encoding\-error\-handler\fR=\fIOUTPUT_ENCODING_ERROR_HANDLER\fR
Specify the error handler for unencodable characters
in the output.  Acceptable values include "strict",
"ignore", "replace", "xmlcharrefreplace", and
"backslashreplace" (in Python 2.3+).  Default is
"strict".  Usually specified as part of
\-\-output-encoding.
.TP
\fB\-\-error\-encoding\fR=\fI<name[:handler]>\fR, \fB\-e\fR \fI<name[:handler]>\fR
Specify the text encoding for error output.  Default
is ASCII.  Optionally also specify the error handler
for unencodable characters, after a colon (":");
default is "backslashreplace".
(See "\-\-output-encoding-error-handler".)
.TP
\fB\-\-error\-encoding\-error\-handler\fR=\fIERROR_ENCODING_ERROR_HANDLER\fR
Specify the error handler for unencodable characters
in error output.  See \-\-output-encoding-error-handler
for acceptable values.  Default is "backslashreplace".
Usually specified as part of \-\-error-encoding.
.TP
\fB\-\-language\fR=\fI<name>\fR, \fB\-l\fR \fI<name>\fR
Specify the language of input text (ISO 639 2-letter
identifier).  Default is "en" (English).
.TP
\fB\-\-record\-dependencies\fR=\fI<file>\fR
Write dependencies (caused e.g. by file inclusions) to
<file>.  Useful in conjunction with programs like
"make".
.TP
\fB\-\-config\fR=\fI<file>\fR
Read configuration settings from <file>, if it exists.
.TP
\fB\-\-version\fR, \fB\-V\fR
Show this program's version number and exit.
.TP
\fB\-\-help\fR, \fB\-h\fR
Show this help message and exit.

.SS
\fBreStructuredText Parser Options\fR
.TP
\fB\-\-pep\-references\fR
Recognize and link to standalone PEP references (like
"PEP 258").
.TP
\fB\-\-pep\-base\-url\fR=\fI<URL>\fR
Base URL for PEP references (default
"http://www.python.org/peps/").
.TP
\fB\-\-rfc\-references\fR
Recognize and link to standalone RFC references (like
"RFC 822").
.TP
\fB\-\-rfc\-base\-url\fR=\fI<URL>\fR
Base URL for RFC references (default
"http://www.faqs.org/rfcs/").
.TP
\fB\-\-tab\-width\fR=\fI<width>\fR
Set number of spaces for tab expansion (default 8).
.TP
\fB\-\-trim\-footnote\-reference\-space\fR
Remove spaces before footnote references.
.TP
\fB\-\-leave\-footnote\-reference\-space\fR
Leave spaces before footnote references.
.TP
\fB\-\-no\-file\-insertion\fR
Disable directives that insert the contents of
external file ("include" & "raw"); replaced with a
"warning" system message.
.TP
\fB\-\-file\-insertion\-enabled\fR
Enable directives that insert the contents of external
file ("include" & "raw").  Enabled by default.
.TP
\fB\-\-no\-raw\fR
Disable the "raw" directives; replaced with a
"warning" system message.
.TP
\fB\-\-raw\-enabled\fR
Enable the "raw" directive.  Enabled by default.

.SS
\fBStandalone Reader\fR
.TP
\fB\-\-no\-doc\-title\fR
Disable the promotion of a lone top-level section
title to document title (and subsequent section title
to document subtitle promotion; enabled by default).
.TP
\fB\-\-no\-doc\-info\fR
Disable the bibliographic field list transform
(enabled by default).
.TP
\fB\-\-section\-subtitles\fR
Activate the promotion of lone subsection titles to
section subtitles (disabled by default).
.TP
\fB\-\-no\-section\-subtitles\fR
Deactivate the promotion of lone subsection titles.

.SS
\fBODF-Specific Options\fR
.TP
\fB\-\-stylesheet\fR=\fI<URL>\fR
Specify a stylesheet URL, used verbatim.  Overrides
\-\-stylesheet-path.
.TP
\fB\-\-stylesheet\-path\fR=\fI<file>\fR
Specify a stylesheet file, relative to the current
working directory.  The path is adjusted relative to
the output ODF file.  Overrides \-\-stylesheet.
.TP
\fB\-\-cloak\-email\-addresses\fR
Obfuscate email addresses to confuse harvesters while
still keeping email links usable with
standards-compliant browsers.
.TP
\fB\-\-table\-border\-thickness\fR=\fITABLE_BORDER_THICKNESS\fR
Specify the thickness of table borders in thousands of
a cm.  Default is 35.
.TP
\fB\-\-add\-syntax\-highlighting\fR
Add syntax highlighting in literal code blocks.Default
is No.  Requires installation of Pygments.
.SH AUTHOR
This man page was generated from the \-\-help output of the tool it documents, using a script written by Simon McVittie for the Debian GNU/Linux system. The script may be used by others: please see the Debian source package python-docutils if you're interested.
